/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.parser.grammar.errors;

import java.util.ArrayList;
import java.util.Collections;

import org.dei.perla.parser.grammar.Token;
import org.dei.perla.parser.grammar.errors.IError.ErrorPriority;
import org.dei.perla.parser.util.ParserLogger;
import org.dei.perla.utils.logger.LogRecord.Type;
import org.dei.perla.utils.logger.LogRecord.Verbosity;

/**
 * Logica di memorizzazione e visualizzazione degli errori all'utente
 */
public class ErrorPool {

	/**
	 * Struttura di memorizzazione degli errori
	 */
	private ArrayList<AbstractError> errors = null;
	
	/**
	 * Istanza dell'oggetto errorPool
	 */
	private static ErrorPool errorPool = null;
	
	/**
	 * Costruttore
	 */
	protected ErrorPool() {
		
		errors = new ArrayList<AbstractError>();
	}
	
	/**
	 * Crea (se necessario) e restituisce l'istanza di ErrorPool
	 * @return
	 */
	public static ErrorPool getInstance() {
		
		if (errorPool == null) {
			
			errorPool = new ErrorPool();
		}
		
		return errorPool;
	}
	
	/**
	 * Libera l'istanza dell'oggetto durante la distruzione
	 */
	public void finalize() {
		
		errorPool = null;
	}
	
	/**
	 * Aggiunge un errore generico alla lista
	 * 
	 * @param errorDescription descrizione generale dell'errore
	 * @param errorDetails dettagli dell'errore
	 * @param errorPriority priorita' dell'errore
	 */
	public void addError(String errorDescription, String errorDetails, ErrorPriority errorPriority) {
		
		// Controlla che i valori necessari per la memorizzazione dell'errore siano presenti
		if (errorDescription == null || errorDescription == "" || errorPriority == null) {
			
			// Notifica ai logger
			ParserLogger.getInstance().printMessage(Type.Warning, Verbosity.Medium, "ErrorPool.addError (general)", "E' stato inserito un errore senza specificare alcuna priorita' o descrizione!", "");
			
			// Aggiunge dei valori di default
			errorPriority = ErrorPriority.MEDIUM;
			errorDescription = "Unknown error";
		} 
		
		// Aggiunge l'errore alla lista
		errors.add(new GeneralError(errorDescription, errorDetails, errorPriority));
	}
	
	/**
	 * Aggiunge un errore di parsing alla lista
	 * 
	 * @param errorDescription descrizione generale dell'errore
	 * @param errorDetails dettagli dell'errore
	 * @param errorToken token corrispondente all'elemento che ha generato l'errore
	 * @param errorPriority priorita' dell'errore
	 */
	public void addError(String errorDescription, String errorDetails, Token errorToken, ErrorPriority errorPriority) {
		
		// Controlla che i valori necessari per la memorizzazione dell'errore siano presenti
		if (errorDescription == null || errorDescription == "" || errorPriority == null || errorToken == null) {
			
			// Notifica ai logger
			ParserLogger.getInstance().printMessage(Type.Warning, Verbosity.Medium, "ErrorPool.addError (parsing)", "E' stato inserito un errore senza specificare alcuna priorita' o descrizione!", "");
			
			// Aggiunge dei valori di default
			errorPriority = ErrorPriority.MEDIUM;
			errorDescription = "Unknown error";
		} 
		
		// Se il Token e' presente...
		if (errorToken != null) {
			
			// Aggiunge l'errore alla lista
			errors.add(new ParsingError(errorDescription, errorDetails, errorToken, errorPriority));
			
		// Altrimenti...
		} else {
			
			// Fallback, aggiungiamo un semplice errore visto che ci manca il token
			errors.add(new GeneralError(errorDescription, errorDetails, errorPriority));
		}
		
	}
	
	/**
	 * Visualizza a video gli errori memorizzati
	 */
	public void printOnConsole() {
		
		// Ordina i vari errori per priorita'
		Collections.sort(errors);
		
		// Controllo presenza di errori ed eventuale printout 
		if (errors.size() == 0) {
			
			System.out.println("Nessun errore trovato.");
		} else {
			
			// Visualizza il contenuto di ogni errore
			for (AbstractError error : errors) {
				
				System.out.println(error.getCompleteErrorDetails() + "\n");
			}
		}
	}
	
	/**
	 * Esegue il reset della struttura di memorizzazione degli errori
	 */
	public void reset() {
		
		errors = new ArrayList<AbstractError>();
	}
}
